/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.apache.commons.net.ftp;

/**
 * Performs filtering on {@link FTPFile} instances.
 *
 * @since 2.2
 */
public interface FTPFileFilter {

    /**
     * Checks if an FTPFile entry should be included or not.
     *
     * @param file entry to be checked for inclusion. May be {@code null}.
     * @return {@code true} if the file is to be included, {@code false} otherwise.
     */
    boolean accept(FTPFile file);
}
